home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ktshop11.zip / KTSHOPER.DOC < prev    next >
Text File  |  1992-04-27  |  21KB  |  514 lines
  1.                          KTShopper v1.1
  2.  
  3.                   "The On-Line Shopping Center"
  4.  
  5.                       Copyright(c) 1992 by
  6.  
  7.                        Kelsey Technologies
  8.                           P.O. Box 288
  9.                       St. Mary's, GA  31558
  10.  
  11.                       Voice: (912) 882-0533
  12.                        BBS: (912) 882-3588
  13.  
  14.                        All Rights Reserved
  15. What is KTShopper?
  16.  
  17.      KTShopper is the On-Line Shopping Center Door for Bulletin
  18.      Boards. KTS can be set up to have multiple shops/categories,
  19.      track customer purchases, maintain an extensive products
  20.      database, and can be configured either locally or remotely by
  21.      the SysOp using two levels of password protection.
  22.  
  23.  
  24. What you need to run KTShopper:
  25.  
  26.      You will need at least 512K free RAM (Extended/Expanded/or
  27.      Swapped to Disk) and the following two lines MUST be included
  28.      in your CONFIG.SYS FILE: FILES=40 BUFFERS=40 (These are the
  29.      minimum)
  30.  
  31.      Also, KTShopper could be run from floppy for local updating
  32.      etc, however, it's not recommended while using On-Line.
  33.  
  34.      DOORWAY.EXE - You will need to obtain the latest DOORWAY
  35.      (DRWY212.ZIP). Doorway will allow KTShopper (or any other non-
  36.      communicating program) to be set-up as a door. In fact, you
  37.      can actually make a Direct Screen Writing Program a Door
  38.      (Lotus, dBASE, WP5.1, and anything else you can imagine). We
  39.      highly encourage you to register your copy of DoorWay, the
  40.      $30.00 fee is well worth it. Please Note: KTShopper does not
  41.      require you to use the registered version of DoorWay to run,
  42.      however, after a reasonable amount of time, as with all
  43.      shareware, you should pay the registration fee.
  44.  
  45.      If you can't find the latest copy of DoorWay, please call the
  46.      Kelsey Technologies Support BBS at (912) 882-3588 and download
  47.      DRWY212.ZIP (The latest as of this writing).
  48.  
  49.  
  50. Files included with KTShopper:
  51.  
  52.      KTSHOPER.EXE        Main Executable File
  53.      KTSHOPER.CFG        Sample Configuration File
  54.      KTSHOPER.DOC        ASCII Docs
  55.      KTSHOPER.WP         WP 5.1 Docs
  56.      KTSHOPER.XLT        Key Translation Table For DoorWay
  57.      KTSHOPER.BAT        Sample Batch File For Calling KTShopper
  58.      CUSTOMER.DBF        dBASE File of Customers
  59.      CUSTOMER.NTX        Index File for Customers
  60.      CUSTOMER.DBT        Notes File for Customers
  61.      ORDERS  .DBF        dBASE File for Orders 
  62.      ORDERS  .NTX        Index File for Orders
  63.      PRODUCTS.DBF        dBASE File of Products
  64.      PRODUCTS.NTX        Index File for Products
  65.      PRODUCTS.DBT        Notes File for Products
  66.      KTNEW1  .TXT        First New Registration Message
  67.      KTNEW2  .TXT        Second New Registration Message
  68.      REGISTER.FRM        Registration Form for KTShopper v1.1 Data File Structures:
  69.  
  70.      CUSTOMER:
  71.  
  72.           CUSTNO    C    10        Customer ID Number
  73.           COMPANY   C    40        Company Name
  74.           NAME      C    20        Contact Name
  75.           ADDRESS1  C    50        Address Line 1
  76.           ADDRESS2  C    50        Address Line 2
  77.           CITY      C    30        City
  78.           ST        C    02        State
  79.           ZIP       C    05        Zip Code
  80.           PAYMENT   C    01        Payment Terms Code
  81.           DISCOUNT  N    05   02   Discount Percentage
  82.           PHONE     C    14        Phone Number
  83.           NOTES     M    10        Additional Customer Info
  84.  
  85.      PRODUCTS:
  86.  
  87.           ITEMNO    C    10        Item No/Stock No/etc
  88.           DESCRIPT  C    40        Item Description
  89.           CAT       C    20        Category/Shop/Store
  90.           PRICE_EA  N    08   02   Price 1-2
  91.           PRICE_3EA N    08   02   Price 3+
  92.           NOTES     M    10        Additional Product Info
  93.  
  94.      ORDERS:
  95.  
  96.           ORD_DATE  D    08        Date of Order
  97.           SHP_DATE  D    08        Date of Shipment 
  98.           CUSTNO    C    10        Customer ID Number
  99.           CUSTOMER  C    40        Customer Name
  100.           ITEMNO    C    10        Item No/Stoc No/etc
  101.           DESCRIPT  C    40        Item Description
  102.           SHIP_VIA  C    10        How Shipped/Wants Shipped
  103.           PRICE     N    08   02   Price Each (Incl Discounts)
  104.           DISCOUNT  N    05   02   Discount Percentage
  105.           QTY       N    04   00   Quantity Ordered
  106.           TAX       N    08   02   Taxes (If any)
  107.           SHIPPING  N    08   02   Shipping Charges (If any)
  108.           PRICE_EXT N    08   02   Grand Total
  109.  
  110.  
  111. GETTING STARTED:
  112.  
  113.      UnZip/LZH/ARJ/whatever the files to the directory you plan to
  114.      run KTShopper from.
  115.  
  116.      NOTE: We have included a configuration file similar to the one
  117.      we use. You are free to change any of the items as you see
  118.      fit.      Enter [KTSHOPER CONFIG] This will start the configuration
  119.      program.
  120.  
  121. Page One-
  122.  
  123.      Enter BBS Name: Enter your BBS Name Here.
  124.  
  125.      Enter Your Name: Enter the SysOp name here.
  126.  
  127. Page Two-
  128.  
  129.      NOTE: The following four questions concern the color scheme
  130.      you wish to use. We have included the colors we use and they
  131.      seem to work great with monochrome/Herc very well. The Color
  132.      strings are identical to dBASE III Plus color strings. These
  133.      are what they mean:
  134.  
  135.           BLACK          N
  136.           BLUE           B
  137.           GREEN          G
  138.           CYAN           BG
  139.           RED            R
  140.           MAGENTA        RB
  141.           BROWN          GR
  142.           WHITE          W
  143.           GRAY           N+
  144.           YELLOW         GR+
  145.           UNDERLINE      U
  146.           INVERSE        I
  147.           BLINKING       *
  148.           HIGH INTENSITY +
  149.  
  150.      The syntax is: [<standard>,[<enhanced>]
  151.  
  152.           Bright White on Blue would be W+/B
  153.  
  154.           Bright White on Blue Standard and Yellow on Black
  155.           Enhanced, would be W+/B,GR+/N
  156.  
  157.      Don't change any of the colors right now, just write down what
  158.      we have set and when you run KTShopper you will begin to see
  159.      how it all works. You can always come back and change them
  160.      later.
  161.  
  162. Page Three-
  163.  
  164.      Enter SysOp Customer Number: This will be YOUR Customer Number
  165.      for entering the SysOp Utilities Menu. When you enter your ID
  166.      in this field, you will then be prompted to enter the correct
  167.      PassWord to gain access to the SysOp Utilities. This is step
  168.      one in a two part security system.      Enter SysOp Password: This is step two in the Security System
  169.      for gaining access to the SysOp Utilities.
  170.  
  171.      Enter Warranty Notice: This is just a Set-Up for whom ever
  172.      will warranty the products you will be selling. Take a look at
  173.      ours to get an idea of what to put in this field.
  174.  
  175.      Who will warranty the products: This will be the Name and
  176.      Address of the company actually selling and providing the
  177.      warranties for the products sold through KTShopper.
  178.  
  179.      Enter State for Tax Computation: Enter Your State. KTShopper
  180.      will look at the customer file to determine if they are in or
  181.      out of state for figuring Taxes.
  182.  
  183.      Enter Tax Rate (6%=.06): This is your state tax rate.
  184.  
  185.      Enter Thank You Message: This message will be displayed after
  186.      the user places an order.
  187.  
  188.      Enter Payment Options: This line will be displayed after the
  189.      "Payment Option Desired" field during New Customer
  190.      Registration. In the Customer Database, you have only One
  191.      character to use for Payment Codes. Plan accordingly.
  192.  
  193. Page Four-
  194.  
  195.      Enter your Categories/Stores/etc for the letters A-W:
  196.  
  197.      Here is where you will create your stores/categories/etc. You
  198.      can see how we have ours set up. We only have one store, but
  199.      multiple categories.
  200.  
  201.      NOTES ABOUT CATEGORIES/STORES:
  202.  
  203.      The names you place in these fields MUST correspond to the
  204.      names you place in the CAT field of the PRODUCTS database.
  205.      This is how KTShopper determines what the customer is looking
  206.      for.
  207.  
  208.      You don't need to complete each field, just the ones you need.
  209.      Should the user press a letter that's not available, KTShopper
  210.      will simply ignore the request.
  211.  
  212.      When you are finished, you will be asked if everything is
  213.      correct. Simply reply with a Y or N and make necessary changes
  214.      as needed.
  215.  
  216.  
  217.      After completing the Categories/Stores fields, you will be
  218.      returned to DOS. UPDATING THE DATABASES:
  219.  
  220.      At the DOS prompt, enter [KTSHOPER] and press Enter.
  221.  
  222.      You will see the opening screen, just as the user will see.
  223.      Read the information then press any key.
  224.  
  225.      NOTE: while on-line, you must enable the doorway mode of your
  226.      communications program or use the indicated keys to navigate
  227.      the cursor.
  228.  
  229.      Enter Your Customer Number (the one you entered previously
  230.      during configuration). If you didn't change it, it's SYSOP.
  231.  
  232.      Enter Your Password (the one you entered previously during
  233.      configuration). If you didn't change it, it's PASSWORD.
  234.  
  235.      Provided you entered the correct Customer Number and Password,
  236.      you will see the SysOp Utilities Menu.
  237.  
  238. Products-
  239.  
  240.      Add a few products to the Products File by pressing [A] for
  241.      Products.
  242.  
  243.      NOTE: If you have ever used the BROWSE mode in dBASE, you will
  244.      have no problems with these utilities. If not, the cursor keys
  245.      move right, left, up, down, and the PgUp and PgDn keys do just
  246.      that.
  247.  
  248.      You will see we have entered a few samples for your review.
  249.  
  250.      Press [A] to ADD a new product.
  251.  
  252.      Enter your Item Number or Stock Number or Model Number or
  253.      whatever.
  254.  
  255.      Next enter a short description.
  256.  
  257.      Now enter which Store or Category this product falls under.
  258.      NOTE: THIS FIELD MUST BE IDENTICAL TO THE CATEGORY/STORE
  259.      FIELDS YOU ENTERED DURING CONFIG.
  260.  
  261.      Enter the Price Each.
  262.  
  263.      Enter the Price for buying three or more.
  264.  
  265.      You will now be in the notes editor. You can enter up to 64K
  266.      of information about this product that the user will be able
  267.      to read while on-line. When you are finished, press Ctrl-W to
  268.      save or Escape to cancel the Notes entry.      You will be returned to the Browse Mode.
  269.  
  270.      Notes:
  271.  
  272.      [D]elete, [E]dit, [V]iew, and [Esc]-quit are self explanatory.
  273.  
  274.      [S]earch allows you to search for a product (by DESCRIP).
  275.  
  276. Customers-
  277.  
  278.      The CUSTNO field in the Customers database will NOT be updated
  279.      automatically. After a new customer Registers in KTShopper,
  280.      you will be required to assign them a Customer Number.
  281.  
  282.      The DISCOUNT field is not automatically updated either. For
  283.      your REALLY good customers, you can assign a discount
  284.      percentage to be applied to the PRICE_EA field. If the
  285.      customer has a discount, KTShopper will inform them and set
  286.      the Price Each to reflect the discounted amount. Discounts
  287.      don't apply towards the PRICE_3EA field. If a customer doesn't
  288.      have a discount, they will never know it as KTShopper makes no
  289.      reference to discounts unless the Discount Field is greater
  290.      than Zero.
  291.  
  292.      The NOTES field is used to keep any additional information
  293.      about the Customer. The user doesn't have any access to this
  294.      information, it's just for you.
  295.  
  296. Orders-
  297.  
  298.      The Orders database is updated as new orders are placed.
  299.  
  300.      The SHP_DATE field is for your use to determine when the
  301.      product was shipped (or ordered from the supplier or whatever)
  302.      This is for your use only, the user can't access it.
  303.  
  304.      The SHIP_VIA field is used to determine how the customer wants
  305.      his products shipped. You will have to determine this after
  306.      verifying his information and discussing payment/shipping
  307.      terms.
  308.  
  309.      The SHIPPING field is reserved for future use. Have any ideas?
  310.      Give us some input on how you would like the Shipping charges
  311.      handled. What we were thinking is to create another database
  312.      with the UPS Zone charts which could then compute the shipping
  313.      charges based on the weight of the product and the destination
  314.      of the products.......Let us know what you want... Re-Config-
  315.  
  316.      The Re-Config option allows you to enter the Configuration
  317.      System. Exactly as if you had started KTShopper with the
  318.      KTSHOPER CONFIG statement. NOTE: YOU WILL BE RETURNED TO DOS
  319.      OR RETURNED TO THE BBS (IF ONLINE), AFTER RUNNING RE-CONFIG.
  320.      This allows you to Re-Config from Remote.
  321.  
  322. USING KTSHOPPER:
  323.  
  324.      From DOS, enter [KTSHOPER] and press Enter.
  325.  
  326.      Set your DOORWAY MODE to on if remote and press any key.
  327.  
  328.      Leave the Customer Number BLANK to register as a new user.
  329.  
  330.      Select Register.
  331.  
  332.      Read the welcome screen. NOTE: THIS SCREEN CAN BE MODIFIED TO
  333.      YOUR LIKING. This screen is contained in an ASCII file called
  334.      KTNEW1.TXT.
  335.  
  336.      Press any key to continue...
  337.  
  338.      Enter your company information. Notice the last line under
  339.      Payment Options. This is configured from the Configuration
  340.      System as seen earlier.
  341.  
  342.      When finished, you will have the option of changing the
  343.      information. If everything is ok, respond with a [Y].
  344.  
  345.      The next screen can be found in KTNEW2.TXT, a standard ASCII
  346.      text file which you can change to your liking.
  347.  
  348.      Press any key to continue...
  349.  
  350.      The goodbye message will appear which can be found in the
  351.      KTBYE.TXT file. NOTE: ONLY REGISTERED USERS CAN CHANGE THE
  352.      GOODBYE MESSAGE.
  353.  
  354.      You will be returned to DOS or the BBS if online.
  355.  
  356.      It's up to you, the SysOp to update the customer file and give
  357.      the new users a Customer Number. They will NOT have access to
  358.      the system until you do so. Be sure to either leave them a
  359.      message on the BBS or call them (that's what we do) with their
  360.      Customer Number.
  361.  
  362.      After you update the Customer File, and give your new company
  363.      a Customer Number, Start KTShopper again to see how it all
  364.      works. Enter KTSHOPER, and press Enter.      Enter your customer number as requested, the Categories/Stores
  365.      will be presented. If you haven't changed the samples yet,
  366.      select (B) Books and press enter.
  367.  
  368.      You will see some sample books we have entered. Move your
  369.      cursor to the one you're interested in.
  370.  
  371.      Now move the cursor over to the Notes Field and press Enter.
  372.  
  373.      The description will appear which was entered into the
  374.      Products Database from the SysOp Utilities Menu.
  375.  
  376.      Press Escape to exit the Notes. and select [A]dd New Order.
  377.  
  378.      Your customer name, discount (if any), item number, price ea,
  379.      price x3, and description will be presented. Enter the
  380.      quantity you would like to order.
  381.  
  382.      The Shipping (not yet), Tax (if in state), and the Grand Total
  383.      will be calculated. You will then be asked if you would like
  384.      to actually place the order. Respond with a [Y]es.
  385.  
  386.      The Thank You message (as found in the configuration system)
  387.      will be displayed for a few seconds and then return to the
  388.      Browse mode of the selected Category/Store.
  389.  
  390.      Press Escape to quit. You will be returned to the
  391.      Category/Stores screen. Select [X] Return to BBS option.
  392.  
  393.      The KTBYE.TXT message will appear for about 6 seconds then
  394.      return to DOS or the BBS if on-line.
  395.  
  396. Filling The Order-
  397.  
  398.      Now you would go into the Orders Database through the SysOp
  399.      utilities menu and fill your orders. You can delete them as
  400.      they are filled or keep them for future records. It's really
  401.      up to you as KTShopper doesn't look at past orders. INSTALLING KTShopper AS A DOOR:
  402.  
  403.      As mentioned earlier, you will need to have DOORWAY to use
  404.      KTShopper. If you can't find it, call our BBS at (912) 882-
  405.      3588 and download it from us. (DRWY212.ZIP)
  406.  
  407.      Our batch file to run KTShopper is like this:
  408.  
  409.      @ECHO OFF
  410.      CD C:\BBS\DOORS\KTSHOPER
  411.      C:DOORWAY SYS /O:T /V:D /A:ON /S:C:\BBS /B:MSZ /X:KTSHOPER.XLT /P:KTSHOPER.EXE
  412.      CD C:\BBS
  413.  
  414.      NOTE: We are using TeleGard 2.7 BBS Software and creating a
  415.      DOOR.SYS file in the BBS directory.
  416.  
  417. Brief Explanation Of Switches and DoorWay:
  418.  
  419.      DOORWAY - The Doorway Program Execution
  420.  
  421.      SYS - Read DOOR.SYS. NOTE: PLEASE READ THE DOORWAY USERS
  422.      MANUAL ON SETTING UP DOORWAY FOR OTHER USER FILES I.E.
  423.      PCBOARD.SYS, CALLINFO.BBS, DOORINFx, etc. DOORWAY ALSO SUPPORT
  424.      EVERY COM PORT YOU CAN IMAGINE IF YOU KNOW THE IRQ AND
  425.      INTERRUPTS.
  426.      
  427.      /O:T - Eliminates the Opening DoorWay screen and delay. NOTE:
  428.      this switch will do nothing on the Unregistered version of
  429.      DoorWay.
  430.  
  431.      /V:D - Use Direct Video Mode. This is Required.
  432.  
  433.      /A:ON - Tells the Host Computer to BEEP when someone enters
  434.      this door.
  435.  
  436.      /S:C:\BBS - Tells DoorWay where to look for the Users
  437.      Information File. Ours happens to be in the C:\BBS directory.
  438.  
  439.      /B:MSZ - Tells DoorWay not to use the 25th line when sending
  440.      information out the modem. This is Required.
  441.  
  442.      /X:KTSHOPER.XLT - Tells DoorWay to use a Translation table for
  443.      certain keypresses on the Remote End. Remember the Ctrl-U for
  444.      Up Arrow, Ctrl-D for Down Arrow, etc. This supports those
  445.      users who don't have Doorway Mode in their communications
  446.      program.
  447.  
  448.      /P:KTSHOPER.EXE - Tells DoorWay what file to run. NOTE: If by
  449.      chance someone crashes this program, or any other program
  450.      being run under DoorWay, the user WILL NOT be dropped to DOS.
  451.      They will immediately be returned to the BBS. DoorWay doesn't
  452.      load a copy of Command.com when running programs. Only if you
  453.      tell it to.      Again, we highly recommend you obtain and register DoorWay. It
  454.      is by far the BEST.
  455.  
  456. RUNNING KTShopper on a MULTINODE BBS:
  457.  
  458.      KTShopper as of this release has not been tested on a Multi-
  459.      Node BBS. It is however set up for a networking environment so
  460.      there should be no problems. Let us know how it goes.
  461.  
  462.  
  463. REGISTRATION:
  464.  
  465.  
  466. If you have ever heard of or used any of Lollyco Central Software
  467. Doors, you're looking at one right now. Kelsey Technologies owns
  468. Lollyco Central Software and has decided to stick with the KT name
  469. on ALL software from now on. Anyway, as with the LCS doors, the
  470. same policy will hold true. We provide quality software at
  471. reasonable prices and promise not to produce ANY CRIPPLEWARE, and
  472. you agree to pay for our software. It's pretty simple really. We
  473. are trying to help you and would appreciate you helping us. The
  474. registration fee is $15.00 (regardless of nodes) and that fifteen
  475. bucks is good forever. You will be given access to a special
  476. section of our BBS to download the latest, greatest registered
  477. versions as they become available. We'll not harp on the ShareWare
  478. concept as we're all aware of how it works (especially if you are
  479. a SysOp). You may use our software for a few weeks to determine
  480. it's usefulness and then either pay the registration fee or
  481. discontinue using it. Enough Said....
  482.  
  483. You can find the Registration Form in a file called REGISTER.FRM
  484.  
  485. SUPPORT:
  486.  
  487. If you have any problems/questions/answers/etc, please call our BBS
  488. FIRST. Leave a message to Kelsey Tech (SysOp) and we'll get back to
  489. you that way. However, should you Really be in a fix, call our
  490. offices at (912) 882-0533 between the hours of 10:00 a.m. and 4:00
  491. p.m. Eastern Time, Mon-Fri. If we are not available when you call,
  492. please leave a message and we will return your call a.s.a.p.
  493.  
  494. LEGAL STUFF:
  495.  
  496. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  497. WITHOUT  WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  498. LIMITED TO ANY  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  499. FOR A PARTICULAR  PURPOSE. IN NO EVENT SHALL THE AUTHOR OR ANYONE
  500. INVOLVED WITH THE CREATION  AND PRODUCTION OF THIS PRODUCT BE
  501. LIABLE FOR ANY DIRECT, INDIRECT,  INCIDENTAL, OR CONSEQUENTIAL
  502. DAMAGES RESULTING FROM THE USE OF THIS  PROGRAM.  YOUR USE OF THIS
  503. PROGRAM CONSTITUTES YOUR AGREEMENT TO THIS  DISCLAIMER AND YOUR
  504. RELEASE OF THE AUTHOR FROM ANY FORM OF LIABILITY OR  LITIGATION. LAST & LEAST:
  505.  
  506. If you have a request for KTShopper,(meaning you want it to do
  507. something it can't) please let us know. We are always trying to
  508. improve our software and if we don't hear from you, we'll never
  509. know.......
  510.  
  511.  
  512.                            Thank You!
  513.  
  514.